/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.gobblin.instrumented.extractor;

import java.io.IOException;

import org.apache.gobblin.configuration.WorkUnitState;
import org.apache.gobblin.source.extractor.DataRecordException;
import org.apache.gobblin.stream.RecordEnvelope;


/**
 * Instrumented version of {@link org.apache.gobblin.source.extractor.Extractor} automatically captures certain metrics.
 * Subclasses should implement readRecordImpl instead of readRecord.
 */
public abstract class InstrumentedExtractor<S, D> extends InstrumentedExtractorBase<S, D> {

  public InstrumentedExtractor(WorkUnitState workUnitState) {
    super(workUnitState);
  }

  /**
   * @deprecated provided for test compatibility.
   */
  @Deprecated
  @Override
  public D readRecord(@Deprecated D reuse) throws DataRecordException, IOException {
    return this.readRecordImpl(null);
  }

  @Override
  public final RecordEnvelope<D> readRecordEnvelope()
      throws DataRecordException, IOException {
    return super.readRecordEnvelope();
  }
}
